Add support for setting IWbemContext #103
Conversation
Some queries require setting named context values using the IWbemContext interface. For example, MSFT_NetFirewallProfile returns the firewall status as configured by the local policy. To get the effective policy based on the local + group policies, one must specify the 'PolicyStore' as 'ActiveStore' using the context interface.
src/context.rs
Outdated
| use crate::{WMIConnection, WMIResult}; | ||
|
|
||
| #[derive(Debug, PartialEq, Serialize, Clone)] | ||
| #[serde(untagged)] |
There was a problem hiding this comment.
🤦♂️ Copy + Pasted the Variant enum and forgot to update. Thanks!
src/context.rs
Outdated
| } | ||
| } | ||
|
|
||
| impl WMIConnection { |
There was a problem hiding this comment.
I think it'll be better to try and keep the API closer to the native one, maybe something like
struct WMIContext(IWbemContext);
impl WMIConnection() {
pub fn ctx() -> &mut WMIContext { .. }
}
impl WMIContext {
pub fn set_value(&mut self, key: &str, value: impl Into<ContextValueType>) -> WMIResult<()> { ... }
pub fn delete_all(..) { ... }
}
// Usage should be
// connection.ctx().set_value("IncludeHidden", true)?;
There was a problem hiding this comment.
Ah nice, this is much better. I have updated based on the suggestion, thanks!
| use serde::Deserialize; | ||
|
|
||
| #[test] | ||
| fn verify_ctx_values_used() { |
There was a problem hiding this comment.
Can you also add an async test too? (copy-pasting this is 👌 )
There was a problem hiding this comment.
Also: since get_by_path calls GetObject, we need to pass the ctx there as well. If there's a nice way to test this, that would be great.
There was a problem hiding this comment.
Added the async test.
With respect to GetObject, I updated it to use the context, but I am having a difficult time testing it. I can't seem to find any WMI classes that make use of the context when invoking GetObject. Wish this was documented better...
src/context.rs
Outdated
|
|
||
| /// Clears all named values from the underlying context object. | ||
| pub fn clear_ctx_values(&mut self) -> WMIResult<()> { | ||
| unsafe { self.ctx.DeleteAll().map_err(Into::into) } |
There was a problem hiding this comment.
I think ? and then doing Ok(()) in the end would also work
|
|
||
| #[derive(Debug, PartialEq, Serialize, Clone)] | ||
| #[serde(untagged)] | ||
| pub enum ContextValueType { |
There was a problem hiding this comment.
Maybe add to this a non_exhaustive attribute, so adding more options won't be a breaking change
There was a problem hiding this comment.
We can also replace ContextValueType with Variant / impl Into<Variant>, but then it'll be better to have impl_try_from_variant generate both impls (the new one being impl From<$target_type> for Variant), as well as Into<VARIANT> for Variant
There was a problem hiding this comment.
I had initially started with using Variant but settled for ContextValueType because only a subset of the VARIANT types are supported as per doc.
I guess the benefit of ContextValueType is the caller can't accidentally pass in an unsupported type whereas they can with Variant
There was a problem hiding this comment.
👍 about the doc - this makes a lot of sense.
samin-cf
force-pushed
the
add-support-for-setting-iwbemcontext
branch
from
fce8f21 to
b0a9331
Compare
|
|
||
| #[derive(Debug, PartialEq, Serialize, Clone)] | ||
| #[serde(untagged)] | ||
| pub enum ContextValueType { |
There was a problem hiding this comment.
👍 about the doc - this makes a lot of sense.
Addresses #102
Motivation
I need some way to programmatically determine the effective firewall status for the
Publicprofile. TheMSFT_NetFirewallProfileclass returns this information, but the firewall information is scoped to the local policy. If one has firewall rules configured using a group policy, they will not be reflected in the output.Thanks to this stackoverflow post, it is possible to query the effective firewall status by specifying
PolicyStoreasActiveStoreusing theIWbemContextinterface. This does not seem to be officially documented by Microsoft, but it does seem to work as expected.